-
Notifications
You must be signed in to change notification settings - Fork 5.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Doc][KubeRay] Add description tables for RayCluster Status in the observability doc #47462
[Doc][KubeRay] Add description tables for RayCluster Status in the observability doc #47462
Conversation
…servability doc Signed-off-by: Rueian <[email protected]>
Hi @kevin85421, could you take a look? |
…servability doc Signed-off-by: Rueian <[email protected]>
…servability doc Signed-off-by: Rueian <[email protected]>
|
||
|
||
|
||
#### RayCluster `.Status.Conditions` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I remember that .Status.Conditions
has a feature flag. Can you explain how to enable this feature?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might help also add a warning header here that it's an alpha feature
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
…servability doc Signed-off-by: Rueian <[email protected]>
…servability doc Signed-off-by: Rueian <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some style nits. Please consider using Vale to find these issues in the future. Please excuse any inaccuracies I introduced in my suggestions and correct as needed. Happy to answer any questions you have about the suggestions. Thanks for your contribution!
…servability doc (Vale) Signed-off-by: Rueian <[email protected]>
…servability doc (Vale) Signed-off-by: Rueian <[email protected]>
Hi @angelinalg, thank you so much for reviewing. All suggestions are applied. |
…servability doc (ray-project#47462) Signed-off-by: Rueian <[email protected]> Signed-off-by: ujjawal-khare <[email protected]>
…servability doc (ray-project#47462) Signed-off-by: Rueian <[email protected]> Signed-off-by: ujjawal-khare <[email protected]>
…servability doc (ray-project#47462) Signed-off-by: Rueian <[email protected]> Signed-off-by: ujjawal-khare <[email protected]>
…servability doc (ray-project#47462) Signed-off-by: Rueian <[email protected]> Signed-off-by: ujjawal-khare <[email protected]>
…servability doc (ray-project#47462) Signed-off-by: Rueian <[email protected]> Signed-off-by: ujjawal-khare <[email protected]>
…servability doc (ray-project#47462) Signed-off-by: Rueian <[email protected]> Signed-off-by: ujjawal-khare <[email protected]>
…servability doc (ray-project#47462) Signed-off-by: Rueian <[email protected]> Signed-off-by: ujjawal-khare <[email protected]>
…servability doc (ray-project#47462) Signed-off-by: Rueian <[email protected]> Signed-off-by: ujjawal-khare <[email protected]>
…servability doc (ray-project#47462) Signed-off-by: Rueian <[email protected]> Signed-off-by: ujjawal-khare <[email protected]>
KubeRay v1.2.1 comes with new CRD status improvements that are better documented, specifically the new
RayClusterStatus.Conditions
field.This PR adds a description table for known values of the new
RayClusterStatus.Conditions
, letting users know how to interpret them for tracking RayCluster status or debugging.Another table for the old
RayClusterStatus.State
is also added to this PR so users can compare the differences between these two fields.Preview: https://anyscale-ray--47462.com.readthedocs.build/en/47462/cluster/kubernetes/user-guides/observability.html